Skip to content

feat: Firestore Enterprise edition indexes #8939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 12, 2025

Conversation

ehsannas
Copy link
Contributor

@ehsannas ehsannas commented Aug 5, 2025

No description provided.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @ehsannas, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

I've implemented support for Firestore Enterprise Edition indexes. This feature introduces new index properties such as apiScope, density, multikey, and unique to provide more granular control and capabilities for Firestore indexes. The changes involve updating the core data structures, API interactions, and validation logic to properly handle these new index types.

Highlights

  • New Index Properties: I've introduced support for new index properties: apiScope, density, multikey, and unique. These additions enable more advanced and specialized indexing capabilities, particularly for Firestore Enterprise Edition.
  • API Integration: The Firestore API has been updated to seamlessly integrate these new index properties. This includes modifications to how indexes are converted between API and specification formats, ensuring that all new fields are correctly processed and persisted.
  • Validation and Sorting Enhancements: I've enhanced the validation logic to enforce the correct usage and types for the new index properties. Additionally, the index sorting mechanisms have been updated to properly order indexes based on these new fields, ensuring consistent behavior.
  • Updated Examples and Documentation: To guide users on how to leverage these new features, I've updated the firestore.indexes.json template with example configurations specifically for Firestore Enterprise Edition indexes.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds support for Firestore Enterprise edition indexes by introducing new properties like apiScope, density, multikey, and unique. The changes are comprehensive, touching upon API types, specifications, sorting logic, validation, and API client methods. The accompanying tests are thorough and cover the new functionality well. I've found one minor issue with duplicated code that should be addressed.

@ehsannas
Copy link
Contributor Author

ehsannas commented Aug 7, 2025

Also tested manually. @joehan please see this and this

@ehsannas ehsannas requested a review from joehan August 7, 2025 17:09
Copy link
Contributor

@joehan joehan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just add an entry to CHANGELOG.md

@ehsannas ehsannas merged commit 4f22156 into master Aug 12, 2025
48 checks passed
@ehsannas ehsannas deleted the ehsann/update-firestore-index branch August 12, 2025 19:58
@github-project-automation github-project-automation bot moved this from Approved [PR] to Done in [Cloud] Extensions + Functions Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants